Documentación de Facilities

FacilitiesApi v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

• https://$(catalog.host)/modules

Email: Iberinform Web: Iberinform

Authentication

• API Key (ClientSecretHeader)

  • Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract

• API Key (APIKeyHeader)

  • Parameter Name: X-IBM-Client-Id, in: header.

Default

get__facilities_{organisationID}

Code samples

URL obj = new URL("https://$(catalog.host)/modules/facilities/{organisationID}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(

 new InputStreamReader(con.getInputStream()));

String inputLine;

StringBuffer response = new StringBuffer();

while ((inputLine = in.readLine()) != null) {

 response.append(inputLine);

}

in.close();

System.out.println(response.toString());

const headers = {

 'Accept':'application/json',

 'X-IBM-Client-Id':'API_KEY',

 'X-IBM-Client-Secret':'API_KEY'

};


fetch('https://$(catalog.host)/modules/facilities/{organisationID}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});

GET https://$(catalog.host)/modules/facilities/{organisationID} HTTP/1.1


Accept: application/json

 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY',

);


$client = new \GuzzleHttp\Client();


// Define array of request body.

$request_body = array();


try {

 $response = $client->request('GET','https://$(catalog.host)/modules/facilities/{organisationID}', array(

 'headers' => $headers,

 'json' => $request_body,

 )

 );

 print_r($response->getBody()->getContents());

 }

 catch (\GuzzleHttp\Exception\BadResponseException $e) {

 // handle exception or api errors.

 print_r($e->getMessage());

 }


 // ...

import requests

headers = {

 'Accept': 'application/json',

 'X-IBM-Client-Id': 'API_KEY',

 'X-IBM-Client-Secret': 'API_KEY'

}


r = requests.get('https://$(catalog.host)/modules/facilities/{organisationID}', headers = headers)


print(r.json())

require 'rest-client'

require 'json'


headers = {

 'Accept' => 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY'

}


result = RestClient.get 'https://$(catalog.host)/modules/facilities/{organisationID}',

 params: {

 }, headers: headers


p JSON.parse(result)

# You can also use wget

curl -X GET https://$(catalog.host)/modules/facilities/{organisationID} \

 -H 'Accept: application/json' \

 -H 'X-IBM-Client-Id: API_KEY' \

 -H 'X-IBM-Client-Secret: API_KEY'

GET /facilities/{organisationID}

Parameters

Example responses

200 Response

"{"facilitiesNumber":0,"mainFacility":{"address":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-02T10:30:43.011Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"addressStatus":"string","areaType":{"code":"string","value":"string"},"commercialTitle":"string","descriptions":[{"code":"string","value":"string"}],"expectedRefurbishmentImprovement":"string","expectedRenewalImprovement":"string","geolocation":{"latitude":0,"longitude":0},"incidents":{"code":"string","incidentDetails":[{"dateFrom":"string","dateTo":"string","impact":"string","type":"string"}],"unavailabilityReason":"string"},"investigatedFacility":"string","location":{"code":"string","value":"string"},"machineryLife":"string","ownership":"string","photograph":"string","proficiencyLevel":"string","situation":{"code":"string","value":"string"},"squareMeters":"string","telephone":"string","use":"string"},"notAvailable":"string","otherFacilities":[{"address":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-02T10:30:43.011Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"addressStatus":"string","areaType":{"code":"string","value":"string"},"commercialTitle":"string","descriptions":[{"code":"string","value":"string"}],"expectedRefurbishmentImprovement":"string","expectedRenewalImprovement":"string","geolocation":{"latitude":0,"longitude":0},"incidents":{"code":"string","incidentDetails":[{"dateFrom":"string","dateTo":"string","impact":"string","type":"string"}],"unavailabilityReason":"string"},"investigatedFacility":"string","location":{"code":"string","value":"string"},"machineryLife":"string","ownership":"string","photograph":"string","proficiencyLevel":"string","situation":{"code":"string","value":"string"},"squareMeters":"string","telephone":"string","use":"string"}]}"

Responses

Schemas

ErrorDetail

"{"code":"string","message":"string","principal":"string","status":0}"

Properties

FaciliDetail

"{"facilitiesNumber":0,"mainFacility":{"address":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-02T10:30:43.011Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"addressStatus":"string","areaType":{"code":"string","value":"string"},"commercialTitle":"string","descriptions":[{"code":"string","value":"string"}],"expectedRefurbishmentImprovement":"string","expectedRenewalImprovement":"string","geolocation":{"latitude":0,"longitude":0},"incidents":{"code":"string","incidentDetails":[{"dateFrom":"string","dateTo":"string","impact":"string","type":"string"}],"unavailabilityReason":"string"},"investigatedFacility":"string","location":{"code":"string","value":"string"},"machineryLife":"string","ownership":"string","photograph":"string","proficiencyLevel":"string","situation":{"code":"string","value":"string"},"squareMeters":"string","telephone":"string","use":"string"},"notAvailable":"string","otherFacilities":[{"address":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-02T10:30:43.011Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"addressStatus":"string","areaType":{"code":"string","value":"string"},"commercialTitle":"string","descriptions":[{"code":"string","value":"string"}],"expectedRefurbishmentImprovement":"string","expectedRenewalImprovement":"string","geolocation":{"latitude":0,"longitude":0},"incidents":{"code":"string","incidentDetails":[{"dateFrom":"string","dateTo":"string","impact":"string","type":"string"}],"unavailabilityReason":"string"},"investigatedFacility":"string","location":{"code":"string","value":"string"},"machineryLife":"string","ownership":"string","photograph":"string","proficiencyLevel":"string","situation":{"code":"string","value":"string"},"squareMeters":"string","telephone":"string","use":"string"}]}"

Properties